Skip to main content

Sync Rejected Orders

🗺️ Sync Rejected Order Request

FieldDetails
API NameSyncRejectedOrders
URL Format<protocol>://<domain name:port>/<VirtualDir>/<URL>
Example URLhttps://localhost:8080/OTPA/V1/SyncRejectedOrderDetails
DescriptionThis request retrieves all rejected orders available in the system. Upon receiving this request, the system sends state-based rejected order information messages. The request must include jToken received from the Authentication API response.

🎯 Sync Rejected Order Request Parameters

ParameterData TypeDescription
jMessageTypevarchar(15)Must be sent as SYNC_ORDER_REQ
jManagerIDvarchar(50)Manager Identification Number
jCustomerIdvarchar(50)Customer ID assigned to the user
jExchangeintExchange identifier
jTokenvarchar(512)Authentication token received from the Authentication API
jEntrySequenceNumberint64Last received sequence number; defaults to 0 if not provided
jRequestIDvarchar(255)Echo‑back field

Example Sync Rejected Order Request

{
"jMessageType": "SYNC_ORDER_REQ",
"jManagerID": "<MANAGER1>",
"jCustomerId": "<MEMBER>",
"jToken": "<Token received in the Authentication Response>",
"jEntrySequenceNumber": "<max sequence no>",
"jRequestID": "<Echo back field>"
}

📘 Sync Rejected Order Response

The response contains the following parameters:

ParameterData TypeDescription
jManagerIdvarchar(50)User ID assigned to the user
jCustomerIdvarchar(50)Customer ID assigned to the user
jLastSyncedPacketintIndicates if this is the last packet (1 = last packet)
jNoOfRecordsintNumber of rejected order records
jOrderMessageOrder Detail Structure (array)Array of rejected order messages with size equal to jNoOfRecords
jRequestIDvarchar(255)Echo back field
jResponseIDvarchar(255)System‑generated alphanumeric ID

📄 Rejected Order Detail Structure

Each entry inside jOrderMessage contains the following parameters:

Parameter (Key)Data TypeDescription
Order NumberintUnique order number
Cli Order NumberintGateway/Client order number (system‑generated)
Exchangevarchar(10)Exchange
Scrip TokenintScrip token
SymbolfloatExchange‑provided security scrip name
Seriesvarchar(3)Exchange‑provided security series
InstrumentNamevarchar(20)Instrument name. Valid values:
• Equity = blank
• Future Index = FUTIDX
• Interest Rate Future = FUTINT
• Future Stock = FUTSTK
• Option Index = OPTIDX
• Option Stock = OPTSTK
• MCX/NCDEX Futures = FUTCOM
• MCX Spot = COM
• NCDEX Spot = COMDTY
• NSE Currency Future = FUTCUR, FUTIRD, FUTIRT, OPTCUR
• NSE Currency Spot = INDEX, UNDCUR, UNDIRD, UNDIRT
Expiry Datevarchar(10)Expiry date (ddMMMyyyy, e.g., 24JUN2004). Applicable for F&O only; blank otherwise.
Strike PricefloatStrike price (in rupees). Applicable for options only; otherwise -1.
Option Typevarchar(2)Option type. Applicable for options only; blank otherwise.
Buy SellintBuy/Sell flag:
1 → Buy
2 → Sell
Order Original QtyintOriginal order quantity
Pending QtyintPending quantity
TradedQTYintTraded quantity
DQintDisclosed quantity
Order PricefloatOrder price (in rupees)
Trigger PricefloatTrigger price (in rupees)
Order Typevarchar(10)Order type
Order Statusvarchar(15)Rejected order status
Reasonvarchar(300)Rejection reason
Order Validityvarchar(100)Order validity
Pro/CliintParticipant type:
1 → CLI
2 → PRO
User IDvarchar(10)Client code (blank for PRO users)
DealerCodevarchar(5)Unique user identification code
Part Codevarchar(12)Participant code; otherwise blank
Order Entry Timevarchar(10)Order entry timestamp (e.g., 15Jun2018 15.25.15)
Last Modified Timevarchar(10)Last modified timestamp (e.g., 15Jun2018 15.25.15)
Aliasvarchar(5)Alias ID; blank if not applicable
Productvarchar(5)Product type of the order
Initiated Byvarchar(25)Application from which the order was initiated (e.g., ADMIN, NET)
Modified Byvarchar(25)Application from which the order was modified
Initiated By User Idvarchar(10)User ID that initiated the order
Modified By User Idvarchar(10)User ID that modified the order
Leg IndicatorintSpread leg indicator
LocationIDvarchar(5)Location ID (PIN + NSECTCLBRANCH ID + NSECTCLID + ALGO FLAG + VENDOR CODE)
User Remarksvarchar(50)User-provided remarks
Miscvarchar(50)Miscellaneous values:
SPO-LMT
SPO-MKT
PO-MKT
PO-LMT
SpreadFlagintSpread flag:
1 → Spread
0 → Normal
Spread PricefloatSpread price (in rupees)
AMO Order IDvarchar(50)Order ID for AMO / EQGTD orders; otherwise blank
SequenceNoint64Incremental sequence number
ManagerIdintManager ID
DaysintNumber of days
UniqueCodevarchar(12)Alphanumeric value with special characters

Example Response

{
"jData": {
"ManagerID": "KOTAL_10.0.0.1",
"CustomerId": "KOTAK",
"NoOfRecords": 6,
"OrderDetail": [
{ "MessageCode": 2000, "OrderNumber": 1, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 2, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 3, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 4, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 5, "...": "..." },
{ "MessageCode": 2000, "OrderNumber": 6, "...": "..." }
]
}
}